nwc technical writing 2023
非専門的な人向けに書く
家電の説明書を書いたりしていた
IT系のに徐々に移動してやっていった
複合機、プロ仕様の印刷機
IT系に踏み込んできたきっかけは?
Webマニュアルをやりたかった
紙は差分管理が大変だった
受託でやるのは厳しい、自社だといいな
すごいわかりにくいものをわかりやすくする
元のプロダクトをよくしたらいいんじゃないかなと思うように 開発との距離感はどう?
近いには近いんだけど
うまく混ざれてない
参加するにも後半になっている
はじめから呼んでくれないか
こんな問題を解決してるんだよね、から入りたい
製品による
どうしても後工程になっていた
新しいJSONのキー名どうですか?というのを聞いてきてくれた ライターがいっぱい集まって提案してくれた
頼む側の困ってること
何を渡したら書いてくれるのか
何も書かないのもつらい
書かれすぎても申し訳ない
雑に声かけてくれ
紙などのことは変更が効かない
丁重におことわりする
15文字を70文字になると言ったりしている
職責がしっかりしている
新しくプロパティが増えたことに対して何が嬉しいのかは汲んで書きたい 新しいのが出た時にAPIはどうやって使うんですか?ってなる どうやって伝えるのがいいのかわかりづらい
迷ってもあまり意味がない
ユーザーに向けて書いてない
自分宛てのメモ
人に聞かれたら自分で答えられるように書く
人数多いとこまっちゃうね
製品ごとに3人くらい居る
それぞれ作業分担してる
できるだけ近いドメインで皆で広くみていこうとなってる
周辺知識、業界知識がないと仕様の情報がわからん
そうすると見えてくるものが変わってくる
直したら良いことへの心当たりがでてくる
知らないことを聞くことができるのが良い
ライティングに必要な知識
ブラウザの仕組みとかは自分で勉強する
製品特有の知識
エンジニアに聞くのが楽しい(ノリノリ)
雇う金がない(ドキュメント書くため)
社外向けならわからなくはないが、それを数値化するのが難しい
国際展開する場合には日本語が元になるのでそこが整備されててほしい
サポートチームが隙間で書いてたのをドキュメント書き直していった
「問い合わせが難しくなった」
簡単なものより難しい話になっている
大変だけどちゃんと使ってくれたので嬉しいことです
外に見せるもんじゃないし動いてるのでいいじゃん
サポートにくる質問をドキュメントに書いてという依頼がどれぐらいくるか 削除したら確認するだけで完全に削除してしまうことで取り返しがつかなかった
ドキュメントを最初から最後まで呼んで違和感があったのをリストに上げてくれる
なんでそれやったの?
でもちゃんと呼んでないよねという提言
なので読み合わせした
代わりにIssueはめっちゃ溜まった
これは修正すべきかどうかを比較してプライオリティを決める
260〜330くらいある
スプリントでは必要なものを30だけ取り組むようにやっていってる
のこりの300は見てない
間違ったことを書いてしまった場合
気づいたら治せばいいや精神
修正シール貼ってないからいいや
altの書き方は正解がわからない
図って自分でつくってる?
プロダクトの構造を伝えたいなって時がある
そういうときは画像が必要
ボタンを囲む枠の色はどうする?
色覚特性の配慮で赤はよくない
危険を伝える色なのでこれでいいのか
注意書き増えがち問題
infoとwarningがいっぱいになる
増やしたら消せをやっている
お掃除職人
注意は乱発すると意味がなくなる
補足は最後に置く